Rename "install/" to "pkg/" and fix macOS bundling #690

angela28chen · 2026-01-05T22:50:05Z

Notable changes:

Rename install/ to pkg/ and have separate folders within for host tools, device resources, and plugins
Change logic for locating resources
- Remove CMAKE_GENERATED_INSTALL_DIR_PATH and predict the location of different resources relative to the location of the host tool.
- Split the resolving logic into separate functions that forces the caller to specify which type of resource they are looking for (so that the caller doesn't need knowledge of the layout of resources dir)
- Using device_resources library to expose related CMAKE_GENERATED_* values, to try and keep fewer libraries regenerated upon SHA changing
Fix the mac install/deploy process, moving some processes (macdeployqt, signing, copying of plugin folders and etc.) out of cmake's install stage and into a separate bash script. This is done because cmake's install portion is inflexible (difficult to even add log messages) and it's error-prone to insert blocks of code.
Changed BUILD.md to reference scripts rather than repeat their contents

PSAs:

Make sure to install with cmake right after building and before running any tests, or Dive might not be able to locate resources
dive_profiling_plugin and other external plugins should be copy pasted into pkg/plugins/ now. Best is to do this step when setting up repo & don't delete pkg/plugins while rebuilding

angela28chen · 2026-01-06T18:29:31Z

The next and last step planned is to make the "unified build folder" by putting build_android and pkg/ (formerly install/) under build

angela28chen · 2026-01-06T18:37:05Z

High-level summary of pkg/ which was formerly the install/ folder

.
├── device
│   ├── DEVICE_RESOURCES_VERSION.csv
│   ├── gfxr-replay.apk
│   ├── gfxrecon.py
│   ├── libVkLayer_dive.so
│   ├── libVkLayer_gfxreconstruct.so
│   ├── libVkLayer_khronos_validation.so
│   ├── libVkLayer_rt_dive.so
│   ├── libwrap.so
│   ├── libXrApiLayer_dive.so
│   └── XrApiLayer_dive.json
├── dive.app
│   └── Contents
├── host
│   ├── dive_client_cli
│   └── NOTICE
└── plugins
    ├── dive_profiling_plugin
    └── dive_sample_plugin

Host tools, UI, mac application should all be able to locate these resources when launched from under pkg/. Also have support for Windows specifically and launching UI from build\ui\Debug\dive.exe for the VS debugger users. For releases, if the file structure here is preserved then the files should still be locatable.

hysw · 2026-01-06T22:37:50Z

What is the rationale to put host tool in pkg/host instead of pkg?

.gitignore

angela28chen · 2026-01-07T15:57:05Z

What is the rationale to put host tool in pkg/host instead of pkg?

It's a little easier to copy files from pkg/host/ for the apple bundle, also if you want to do a clean build for just the host side you can rm -rf pkg/host. I think in general it also helps with understanding the system while we still have the dual build thing (i.e. these are the direct outputs from building host tools).

scripts/deploy_mac_bundle.sh

src/dive/utils/device_resources.cpp

.gitignore

BUILD.md

capture_service/device_mgr.cc

src/dive/build_defs/version_defs.h

src/dive/utils/device_resources.cpp

angela28chen · 2026-01-08T21:21:06Z

Manual Testing (2026/01/16 1:15 EST):

Windows
- manually added profiling plugin folder
- pkg\host\dive_client_cli.exe --version
- Verified UI "About Dive" correct version string and 3rd party license files (from VS debugger)
Mac
- manually added profiling plugin folder
- dive_client_cli --version (three locations)
- Verified UI "About Dive" correct version string and 3rd party license files (from launching app bundle)

BUILD.md

src/dive/utils/device_resources.cpp

src/dive/build_defs/resource_defs.h

ui/CMakeLists.txt

ui/about_window.cpp

angela28chen · 2026-01-13T17:15:39Z

I just realized this PR has an issue with handling paths for plugins, I am working on fixing that

EDIT: addressed this, note that pkg/plugins exists now

…erated variables, some fixes for plugins, add search path for VS debugger use

…resubmits, changed documentation to reflect that order, fixed executable locations for the UI regression tests

BUILD.md

ui/about_window.cpp

angela28chen · 2026-01-16T21:06:20Z

github bug with invisible unresolved comment that blocks merging, will recreate PR

angela28chen force-pushed the fix-mac2 branch from 74de8ba to f4e390e Compare January 5, 2026 22:53

This was referenced Jan 5, 2026

[PoC] Restructure build and install folders to make it more similar across different platforms, build types, and release types #640

Closed

Copies notice to app bundle for mac #673

Closed

angela28chen force-pushed the fix-mac2 branch 3 times, most recently from 47a0627 to da5faf9 Compare January 6, 2026 18:10

angela28chen force-pushed the fix-mac2 branch from da5faf9 to e9e2219 Compare January 6, 2026 18:29

angela28chen marked this pull request as ready for review January 6, 2026 18:37

angela28chen requested review from RenfengLiu, footballhead and hysw January 6, 2026 20:16

hysw reviewed Jan 6, 2026

View reviewed changes

.gitignore Show resolved Hide resolved

footballhead reviewed Jan 7, 2026

View reviewed changes

angela28chen force-pushed the fix-mac2 branch 3 times, most recently from e9e2219 to 26b0b05 Compare January 7, 2026 18:35

angela28chen requested review from footballhead and hysw January 7, 2026 18:57

footballhead reviewed Jan 7, 2026

View reviewed changes

angela28chen force-pushed the fix-mac2 branch from 1e2415e to 31f53f8 Compare January 8, 2026 21:13

angela28chen requested a review from footballhead January 8, 2026 21:24

footballhead reviewed Jan 9, 2026

View reviewed changes

angela28chen force-pushed the fix-mac2 branch 2 times, most recently from f41bbc3 to a303dee Compare January 13, 2026 20:49

angela28chen added 4 commits January 16, 2026 12:02

update deploy_mac_bundle.sh

af8362e

Remove resource_defs.h and use device_resources lib to wrap cmake gen…

435ad8d

…erated variables, some fixes for plugins, add search path for VS debugger use

update deploy_mac_bundle.sh to copy plugins/

da0574a

On Windows: added install step and macdeployqt step before tests in p…

21f90e9

…resubmits, changed documentation to reflect that order, fixed executable locations for the UI regression tests

hysw previously approved these changes Jan 16, 2026

View reviewed changes

angela28chen dismissed stale reviews from hysw, wangra-google, and footballhead via 8422e3c January 16, 2026 17:56

angela28chen force-pushed the fix-mac2 branch from d31a905 to 8422e3c Compare January 16, 2026 17:56

Mac: minor fixes to scripts and error logging

7ba3770

angela28chen force-pushed the fix-mac2 branch from 8422e3c to 7ba3770 Compare January 16, 2026 18:09

angela28chen enabled auto-merge (squash) January 16, 2026 18:17

angela28chen requested review from footballhead, hysw and wangra-google January 16, 2026 18:22

wangra-google previously approved these changes Jan 16, 2026

View reviewed changes

footballhead previously approved these changes Jan 16, 2026

View reviewed changes

BUILD.md Outdated Show resolved Hide resolved

ui/about_window.cpp Outdated Show resolved Hide resolved

On Windows: minor fixes

26f4872

angela28chen dismissed stale reviews from footballhead and wangra-google via 26f4872 January 16, 2026 20:19

wangra-google approved these changes Jan 16, 2026

View reviewed changes

footballhead approved these changes Jan 16, 2026

View reviewed changes

angela28chen disabled auto-merge January 16, 2026 20:41

angela28chen enabled auto-merge (squash) January 16, 2026 20:47

angela28chen closed this Jan 16, 2026

auto-merge was automatically disabled January 16, 2026 21:00
Pull request was closed

angela28chen reopened this Jan 16, 2026

angela28chen closed this Jan 16, 2026

angela28chen mentioned this pull request Jan 16, 2026

Rename "install/" to "pkg/" and fix macOS bundling #717

Merged

Rename "install/" to "pkg/" and fix macOS bundling #690

Rename "install/" to "pkg/" and fix macOS bundling #690

Uh oh!

Conversation

angela28chen commented Jan 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

angela28chen commented Jan 6, 2026

Uh oh!

angela28chen commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hysw commented Jan 6, 2026

Uh oh!

Uh oh!

angela28chen commented Jan 7, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angela28chen commented Jan 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angela28chen commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

angela28chen commented Jan 16, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

angela28chen commented Jan 5, 2026 •

edited

Loading

angela28chen commented Jan 6, 2026 •

edited

Loading

angela28chen commented Jan 8, 2026 •

edited

Loading

angela28chen commented Jan 13, 2026 •

edited

Loading